Microsoft Cognitive Language Service - Analyze Text Authoring (stable:2023-04-01)

2025/10/08 • 29 new, 29 deleted methods

TextAnalysisAuthoringListProjects (new)
Description :  Lists the existing projects.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The TextAnalysisAuthoringProjectMetadata items on this page ,
Required: True ,
}
[
{
createdDateTime:
{
Description: Represents the project creation datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedDateTime:
{
Description: Represents the project last modification datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: Represents the project last training datetime. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeployedDateTime:
{
Description: Represents the project last deployment datetime. ,
Format: date-time ,
Required: False ,
}
string ,
projectKind:
{
Description: The project kind. ,
Enum:
{
CustomSingleLabelClassification: For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B. ,
CustomMultiLabelClassification: For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
}
,
Required: True ,
}
enum ,
storageInputContainerName:
{
Description: The storage container name. ,
Required: True ,
}
string ,
settings:
{
Description: The project settings. ,
Required: False ,
}
{
confidenceThreshold:
{
Description: The threshold of the class with the highest confidence, at which the prediction will automatically be changed to "None". The value of the threshold should be between 0 and 1 inclusive. ,
Format: float ,
Required: False ,
}
number ,
}
,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
multilingual:
{
Description: Whether the project would be used for multiple languages or not. ,
Required: False ,
}
boolean ,
description:
{
Description: The project description. ,
Required: False ,
}
string ,
language:
{
Description: The project language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringProject_GetProject (new)
Description :  Gets the details of a project.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
createdDateTime:
{
Description: Represents the project creation datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedDateTime:
{
Description: Represents the project last modification datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: Represents the project last training datetime. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeployedDateTime:
{
Description: Represents the project last deployment datetime. ,
Format: date-time ,
Required: False ,
}
string ,
projectKind:
{
Description: The project kind. ,
Enum:
{
CustomSingleLabelClassification: For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B. ,
CustomMultiLabelClassification: For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
}
,
Required: True ,
}
enum ,
storageInputContainerName:
{
Description: The storage container name. ,
Required: True ,
}
string ,
settings:
{
Description: The project settings. ,
Required: False ,
}
{
confidenceThreshold:
{
Description: The threshold of the class with the highest confidence, at which the prediction will automatically be changed to "None". The value of the threshold should be between 0 and 1 inclusive. ,
Format: float ,
Required: False ,
}
number ,
}
,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
multilingual:
{
Description: Whether the project would be used for multiple languages or not. ,
Required: False ,
}
boolean ,
description:
{
Description: The project description. ,
Required: False ,
}
string ,
language:
{
Description: The project language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringProject_CreateProject (new)
Description :  The most basic operation that applies to a resource.
Reference :  Link ¶

⚼ Request

PATCH:  /authoring/analyze-text/projects/{projectName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
body:
{
Description: The request body ,
Required: True ,
}
{
projectKind:
{
Description: The project kind. ,
Enum:
{
CustomSingleLabelClassification: For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B. ,
CustomMultiLabelClassification: For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
}
,
Required: True ,
}
enum ,
storageInputContainerName:
{
Description: The storage container name. ,
Required: True ,
}
string ,
settings:
{
Description: The project settings. ,
Required: False ,
}
{
confidenceThreshold:
{
Description: The threshold of the class with the highest confidence, at which the prediction will automatically be changed to "None". The value of the threshold should be between 0 and 1 inclusive. ,
Format: float ,
Required: False ,
}
number ,
}
,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
multilingual:
{
Description: Whether the project would be used for multiple languages or not. ,
Required: False ,
}
boolean ,
description:
{
Description: The project description. ,
Required: False ,
}
string ,
language:
{
Description: The project language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
createdDateTime:
{
Description: Represents the project creation datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedDateTime:
{
Description: Represents the project last modification datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: Represents the project last training datetime. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeployedDateTime:
{
Description: Represents the project last deployment datetime. ,
Format: date-time ,
Required: False ,
}
string ,
projectKind:
{
Description: The project kind. ,
Enum:
{
CustomSingleLabelClassification: For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B. ,
CustomMultiLabelClassification: For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
}
,
Required: True ,
}
enum ,
storageInputContainerName:
{
Description: The storage container name. ,
Required: True ,
}
string ,
settings:
{
Description: The project settings. ,
Required: False ,
}
{
confidenceThreshold:
{
Description: The threshold of the class with the highest confidence, at which the prediction will automatically be changed to "None". The value of the threshold should be between 0 and 1 inclusive. ,
Format: float ,
Required: False ,
}
number ,
}
,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
multilingual:
{
Description: Whether the project would be used for multiple languages or not. ,
Required: False ,
}
boolean ,
description:
{
Description: The project description. ,
Required: False ,
}
string ,
language:
{
Description: The project language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
createdDateTime:
{
Description: Represents the project creation datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedDateTime:
{
Description: Represents the project last modification datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: Represents the project last training datetime. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeployedDateTime:
{
Description: Represents the project last deployment datetime. ,
Format: date-time ,
Required: False ,
}
string ,
projectKind:
{
Description: The project kind. ,
Enum:
{
CustomSingleLabelClassification: For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B. ,
CustomMultiLabelClassification: For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
}
,
Required: True ,
}
enum ,
storageInputContainerName:
{
Description: The storage container name. ,
Required: True ,
}
string ,
settings:
{
Description: The project settings. ,
Required: False ,
}
{
confidenceThreshold:
{
Description: The threshold of the class with the highest confidence, at which the prediction will automatically be changed to "None". The value of the threshold should be between 0 and 1 inclusive. ,
Format: float ,
Required: False ,
}
number ,
}
,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
multilingual:
{
Description: Whether the project would be used for multiple languages or not. ,
Required: False ,
}
boolean ,
description:
{
Description: The project description. ,
Required: False ,
}
string ,
language:
{
Description: The project language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringProject_DeleteProject (new)
Description :  Deletes a project.
Reference :  Link ¶

⚼ Request

DELETE:  /authoring/analyze-text/projects/{projectName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringProject_Export (new)
Description :  Triggers a job to export a project's data.
Reference :  Link ¶

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/:export
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
stringIndexType:
{
Description: Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets. ,
Required: True ,
}
string ,
assetKind:
{
Description: Kind of asset to export. ,
Required: False ,
}
string ,
trainedModelLabel:
{
Description: Trained model label to export. If the trainedModelLabel is null, the default behavior is to export the current working copy. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringProject_Import (new)
Description :  Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.
Reference :  Link ¶

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/:import
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
body:
{
Description: The project data to import. ,
Required: True ,
}
{
projectFileVersion:
{
Description: The version of the exported file. ,
Required: True ,
}
string ,
stringIndexType:
{
Description: Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets. ,
Enum:
{
Utf16CodeUnit: The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript. ,
}
,
Required: True ,
}
enum ,
metadata:
{
Description: Represents the project metadata. ,
Required: True ,
}
{
projectKind:
{
Description: The project kind. ,
Enum:
{
CustomSingleLabelClassification: For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B. ,
CustomMultiLabelClassification: For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
}
,
Required: True ,
}
enum ,
storageInputContainerName:
{
Description: The storage container name. ,
Required: True ,
}
string ,
settings:
{
Description: The project settings. ,
Required: False ,
}
{
confidenceThreshold:
{
Description: The threshold of the class with the highest confidence, at which the prediction will automatically be changed to "None". The value of the threshold should be between 0 and 1 inclusive. ,
Format: float ,
Required: False ,
}
number ,
}
,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
multilingual:
{
Description: Whether the project would be used for multiple languages or not. ,
Required: False ,
}
boolean ,
description:
{
Description: The project description. ,
Required: False ,
}
string ,
language:
{
Description: The project language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. ,
Required: True ,
}
string ,
}
,
assets:
{
Description: Represents the project assets. ,
Required: False ,
}
{
projectKind:
{
Enum:
{
CustomSingleLabelClassification: For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B. ,
CustomMultiLabelClassification: For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringProject_Train (new)
Description :  Triggers a training job for a project.
Reference :  Link ¶

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/:train
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
body:
{
Description: The training input parameters. ,
Required: True ,
}
{
modelLabel:
{
Description: Represents the output model label. ,
Required: True ,
}
string ,
trainingConfigVersion:
{
Description: Represents training config version. ,
Required: True ,
}
string ,
evaluationOptions:
{
Description: Represents the evaluation options. By default, the evaluation kind is percentage, with training split percentage as 80, and testing split percentage as 20. ,
Required: False ,
}
{
kind:
{
Description: Represents the evaluation kind. By default, the evaluation kind is set to percentage. ,
Enum:
{
percentage: Split the data into training and test sets according to user-defined percentages. ,
manual: Split the data according to the chosen dataset for every example in the data. ,
}
,
Required: False ,
}
enum ,
trainingSplitPercentage:
{
Description: Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage. ,
Format: int32 ,
Required: False ,
}
integer ,
testingSplitPercentage:
{
Description: Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAnalysisAuthoringListDeployments (new)
Description :  Lists the deployments belonging to a project.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/deployments
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The TextAnalysisAuthoringProjectDeployment items on this page ,
Required: True ,
}
[
{
deploymentName:
{
Description: Represents deployment name. ,
Required: True ,
}
string ,
modelId:
{
Description: Represents deployment modelId. ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: Represents deployment last trained time. ,
Format: date-time ,
Required: True ,
}
string ,
lastDeployedDateTime:
{
Description: Represents deployment last deployed time. ,
Format: date-time ,
Required: True ,
}
string ,
deploymentExpirationDate:
{
Description: Represents deployment expiration date in the runtime. ,
Format: date ,
Required: True ,
}
string ,
modelTrainingConfigVersion:
{
Description: Represents model training config version. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringDeployment_GetDeployment (new)
Description :  Gets the details of a deployment.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
deploymentName:
{
Description: Represents deployment name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
deploymentName:
{
Description: Represents deployment name. ,
Required: True ,
}
string ,
modelId:
{
Description: Represents deployment modelId. ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: Represents deployment last trained time. ,
Format: date-time ,
Required: True ,
}
string ,
lastDeployedDateTime:
{
Description: Represents deployment last deployed time. ,
Format: date-time ,
Required: True ,
}
string ,
deploymentExpirationDate:
{
Description: Represents deployment expiration date in the runtime. ,
Format: date ,
Required: True ,
}
string ,
modelTrainingConfigVersion:
{
Description: Represents model training config version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringDeployment_DeployProject (new)
Description :  Creates a new deployment or replaces an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the specific deployment of the project to use. ,
Required: True ,
}
string ,
body:
{
Description: The new deployment info. ,
Required: True ,
}
{
trainedModelLabel:
{
Description: Represents the trained model label. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringDeployment_DeleteDeployment (new)
Description :  Deletes a project deployment.
Reference :  Link ¶

⚼ Request

DELETE:  /authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the specific deployment of the project to use. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringDeployment_GetDeploymentStatus (new)
Description :  Gets the status of an existing deployment job.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
deploymentName:
{
Description: Represents deployment name. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: The creation date time of the job. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdatedDateTime:
{
Description: The last date time the job was updated. ,
Format: date-time ,
Required: True ,
}
string ,
expirationDateTime:
{
Description: The expiration date time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The job status. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
warnings:
{
Description: The warnings that were encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
errors:
{
Description: The errors encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringProject_SwapDeployments (new)
Description :  Swaps two existing deployments with each other.
Reference :  Link ¶

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/deployments/:swap
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
body:
{
Description: The job object to swap two deployments. ,
Required: True ,
}
{
firstDeploymentName:
{
Description: Represents the first deployment name. ,
Required: True ,
}
string ,
secondDeploymentName:
{
Description: Represents the second deployment name. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringProject_GetSwapDeploymentsStatus (new)
Description :  Gets the status of an existing swap deployment job.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/deployments/swap/jobs/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: The creation date time of the job. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdatedDateTime:
{
Description: The last date time the job was updated. ,
Format: date-time ,
Required: True ,
}
string ,
expirationDateTime:
{
Description: The expiration date time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The job status. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
warnings:
{
Description: The warnings that were encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
errors:
{
Description: The errors encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringProject_GetExportStatus (new)
Description :  Gets the status of an export job. Once job completes, returns the project metadata, and assets.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/export/jobs/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: The creation date time of the job. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdatedDateTime:
{
Description: The last date time the job was updated. ,
Format: date-time ,
Required: True ,
}
string ,
expirationDateTime:
{
Description: The expiration date time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The job status. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
warnings:
{
Description: The warnings that were encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
errors:
{
Description: The errors encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
resultUrl:
{
Description: The URL to use in order to download the exported project. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringProject_GetImportStatus (new)
Description :  Gets the status for an import.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/import/jobs/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: The creation date time of the job. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdatedDateTime:
{
Description: The last date time the job was updated. ,
Format: date-time ,
Required: True ,
}
string ,
expirationDateTime:
{
Description: The expiration date time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The job status. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
warnings:
{
Description: The warnings that were encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
errors:
{
Description: The errors encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAnalysisAuthoringListTrainedModels (new)
Description :  Lists the trained models belonging to a project.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/models
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The TextAnalysisAuthoringProjectTrainedModel items on this page ,
Required: True ,
}
[
{
label:
{
Description: The trained model label. ,
Required: True ,
}
string ,
modelId:
{
Description: The model ID. ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: The last trained date time of the model. ,
Format: date-time ,
Required: True ,
}
string ,
lastTrainingDurationInSeconds:
{
Description: The duration of the model's last training request in seconds. ,
Format: int32 ,
Required: True ,
}
integer ,
modelExpirationDate:
{
Description: The model expiration date. ,
Format: date ,
Required: True ,
}
string ,
modelTrainingConfigVersion:
{
Description: The model training config version. ,
Required: True ,
}
string ,
hasSnapshot:
{
Description: The flag to indicate if the trained model has a snapshot ready. ,
Required: True ,
}
boolean ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringTrainedModel_GetTrainedModel (new)
Description :  Gets the details of a trained model.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
trainedModelLabel:
{
Description: The trained model label. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
label:
{
Description: The trained model label. ,
Required: True ,
}
string ,
modelId:
{
Description: The model ID. ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: The last trained date time of the model. ,
Format: date-time ,
Required: True ,
}
string ,
lastTrainingDurationInSeconds:
{
Description: The duration of the model's last training request in seconds. ,
Format: int32 ,
Required: True ,
}
integer ,
modelExpirationDate:
{
Description: The model expiration date. ,
Format: date ,
Required: True ,
}
string ,
modelTrainingConfigVersion:
{
Description: The model training config version. ,
Required: True ,
}
string ,
hasSnapshot:
{
Description: The flag to indicate if the trained model has a snapshot ready. ,
Required: True ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringTrainedModel_DeleteTrainedModel (new)
Description :  Deletes an existing trained model.
Reference :  Link ¶

⚼ Request

DELETE:  /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
trainedModelLabel:
{
Description: The trained model label. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringTrainedModel_LoadSnapshot (new)
Description :  Long-running operation.
Reference :  Link ¶

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/:load-snapshot
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
trainedModelLabel:
{
Description: The trained model label. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringTrainedModel_GetModelEvaluationResults (new)
Description :  Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/result
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
trainedModelLabel:
{
Description: The trained model label. ,
Required: True ,
}
string ,
top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
stringIndexType:
{
Description: Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The TextAnalysisAuthoringDocumentEvaluationResult items on this page ,
Required: True ,
}
[
{
projectKind:
{
Description: Represents the project kind. ,
Enum:
{
CustomSingleLabelClassification: For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B. ,
CustomMultiLabelClassification: For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
}
,
Required: True ,
}
enum ,
location:
{
Description: Represents the document path. ,
Required: True ,
}
string ,
language:
{
Description: Represents the document language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringTrainedModel_GetModelEvaluationSummary (new)
Description :  Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
trainedModelLabel:
{
Description: The trained model label. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
projectKind:
{
Description: Represents the project type that the evaluation ran on. ,
Enum:
{
CustomSingleLabelClassification: For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B. ,
CustomMultiLabelClassification: For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
}
,
Required: True ,
}
enum ,
evaluationOptions:
{
Description: Represents the options used running the evaluation. ,
Required: True ,
}
{
kind:
{
Description: Represents the evaluation kind. By default, the evaluation kind is set to percentage. ,
Enum:
{
percentage: Split the data into training and test sets according to user-defined percentages. ,
manual: Split the data according to the chosen dataset for every example in the data. ,
}
,
Required: False ,
}
enum ,
trainingSplitPercentage:
{
Description: Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage. ,
Format: int32 ,
Required: False ,
}
integer ,
testingSplitPercentage:
{
Description: Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringTrainedModel_GetLoadSnapshotStatus (new)
Description :  Gets the status for loading a snapshot.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/load-snapshot/jobs/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
trainedModelLabel:
{
Description: The trained model label. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: The creation date time of the job. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdatedDateTime:
{
Description: The last date time the job was updated. ,
Format: date-time ,
Required: True ,
}
string ,
expirationDateTime:
{
Description: The expiration date time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The job status. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
warnings:
{
Description: The warnings that were encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
errors:
{
Description: The errors encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAnalysisAuthoringListTrainingJobs (new)
Description :  Lists the non-expired training jobs created for a project.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/train/jobs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The TextAnalysisAuthoringTrainingJobState items on this page ,
Required: True ,
}
[
{
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: The creation date time of the job. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdatedDateTime:
{
Description: The last date time the job was updated. ,
Format: date-time ,
Required: True ,
}
string ,
expirationDateTime:
{
Description: The expiration date time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The job status. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
warnings:
{
Description: The warnings that were encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
errors:
{
Description: The errors encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
result:
{
Description: Represents training tasks detailed result. ,
Required: True ,
}
{
modelLabel:
{
Description: Represents trained model label. ,
Required: True ,
}
string ,
trainingConfigVersion:
{
Description: Represents training config version. ,
Required: True ,
}
string ,
trainingStatus:
{
Description: Represents model train status. ,
Required: True ,
}
{
percentComplete:
{
Description: Represents progress percentage. ,
Format: int32 ,
Required: True ,
}
integer ,
startDateTime:
{
Description: Represents the start date time. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Represents the end date time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Represents the status of the sub-operation. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
evaluationStatus:
{
Description: Represents model evaluation status. ,
Required: False ,
}
{
percentComplete:
{
Description: Represents progress percentage. ,
Format: int32 ,
Required: True ,
}
integer ,
startDateTime:
{
Description: Represents the start date time. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Represents the end date time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Represents the status of the sub-operation. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
estimatedEndDateTime:
{
Description: Represents the estimate end date time for training and evaluation. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringProject_GetTrainingStatus (new)
Description :  Gets the status for a training job.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: The creation date time of the job. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdatedDateTime:
{
Description: The last date time the job was updated. ,
Format: date-time ,
Required: True ,
}
string ,
expirationDateTime:
{
Description: The expiration date time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The job status. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
warnings:
{
Description: The warnings that were encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
errors:
{
Description: The errors encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
result:
{
Description: Represents training tasks detailed result. ,
Required: True ,
}
{
modelLabel:
{
Description: Represents trained model label. ,
Required: True ,
}
string ,
trainingConfigVersion:
{
Description: Represents training config version. ,
Required: True ,
}
string ,
trainingStatus:
{
Description: Represents model train status. ,
Required: True ,
}
{
percentComplete:
{
Description: Represents progress percentage. ,
Format: int32 ,
Required: True ,
}
integer ,
startDateTime:
{
Description: Represents the start date time. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Represents the end date time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Represents the status of the sub-operation. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
evaluationStatus:
{
Description: Represents model evaluation status. ,
Required: False ,
}
{
percentComplete:
{
Description: Represents progress percentage. ,
Format: int32 ,
Required: True ,
}
integer ,
startDateTime:
{
Description: Represents the start date time. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Represents the end date time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Represents the status of the sub-operation. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
estimatedEndDateTime:
{
Description: Represents the estimate end date time for training and evaluation. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringProject_CancelTrainingJob (new)
Description :  Triggers a cancellation for a running training job.
Reference :  Link ¶

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}/:cancel
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringProject_GetProjectDeletionStatus (new)
Description :  Gets the status for a project deletion job.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/global/deletion-jobs/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: The creation date time of the job. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdatedDateTime:
{
Description: The last date time the job was updated. ,
Format: date-time ,
Required: True ,
}
string ,
expirationDateTime:
{
Description: The expiration date time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The job status. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
warnings:
{
Description: The warnings that were encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
errors:
{
Description: The errors encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAnalysisAuthoringGetSupportedLanguages (new)
Description :  Lists the supported languages.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/global/languages
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectKind:
{
Description: The project kind, default value is CustomSingleLabelClassification. ,
Required: False ,
}
string ,
top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The TextAnalysisAuthoringSupportedLanguage items on this page ,
Required: True ,
}
[
{
languageName:
{
Description: The language name. ,
Required: True ,
}
string ,
languageCode:
{
Description: The language code. This is BCP-47 representation of a language. For example, "en" for English, "en-gb" for English (UK), "es" for Spanish etc. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAnalysisAuthoringListTrainingConfigVersions (new)
Description :  Lists the support training config version for a given project type.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/global/training-config-versions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectKind:
{
Description: The project kind, default value is CustomSingleLabelClassification. ,
Required: False ,
}
string ,
top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The TextAnalysisAuthoringTrainingConfigVersion items on this page ,
Required: True ,
}
[
{
trainingConfigVersion:
{
Description: Represents the version of the config. ,
Required: True ,
}
string ,
modelExpirationDate:
{
Description: Represents the training config version expiration date. ,
Format: date ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAnalysisAuthoringListProjects (removed)
Description :  Lists the existing projects.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The TextAnalysisAuthoringProjectMetadata items on this page ,
Required: True ,
}
[
{
createdDateTime:
{
Description: Represents the project creation datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedDateTime:
{
Description: Represents the project last modification datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: Represents the project last training datetime. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeployedDateTime:
{
Description: Represents the project last deployment datetime. ,
Format: date-time ,
Required: False ,
}
string ,
projectKind:
{
Description: The project kind. ,
Enum:
{
CustomSingleLabelClassification: For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B. ,
CustomMultiLabelClassification: For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
}
,
Required: True ,
}
enum ,
storageInputContainerName:
{
Description: The storage container name. ,
Required: True ,
}
string ,
settings:
{
Description: The project settings. ,
Required: False ,
}
{
confidenceThreshold:
{
Description: The threshold of the class with the highest confidence, at which the prediction will automatically be changed to "None". The value of the threshold should be between 0 and 1 inclusive. ,
Format: float ,
Required: False ,
}
number ,
}
,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
multilingual:
{
Description: Whether the project would be used for multiple languages or not. ,
Required: False ,
}
boolean ,
description:
{
Description: The project description. ,
Required: False ,
}
string ,
language:
{
Description: The project language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringProject_GetProject (removed)
Description :  Gets the details of a project.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
createdDateTime:
{
Description: Represents the project creation datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedDateTime:
{
Description: Represents the project last modification datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: Represents the project last training datetime. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeployedDateTime:
{
Description: Represents the project last deployment datetime. ,
Format: date-time ,
Required: False ,
}
string ,
projectKind:
{
Description: The project kind. ,
Enum:
{
CustomSingleLabelClassification: For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B. ,
CustomMultiLabelClassification: For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
}
,
Required: True ,
}
enum ,
storageInputContainerName:
{
Description: The storage container name. ,
Required: True ,
}
string ,
settings:
{
Description: The project settings. ,
Required: False ,
}
{
confidenceThreshold:
{
Description: The threshold of the class with the highest confidence, at which the prediction will automatically be changed to "None". The value of the threshold should be between 0 and 1 inclusive. ,
Format: float ,
Required: False ,
}
number ,
}
,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
multilingual:
{
Description: Whether the project would be used for multiple languages or not. ,
Required: False ,
}
boolean ,
description:
{
Description: The project description. ,
Required: False ,
}
string ,
language:
{
Description: The project language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringProject_CreateProject (removed)
Description :  The most basic operation that applies to a resource.
Reference :  Link ¶

⚼ Request

PATCH:  /authoring/analyze-text/projects/{projectName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
body:
{
Description: The request body ,
Required: True ,
}
{
projectKind:
{
Description: The project kind. ,
Enum:
{
CustomSingleLabelClassification: For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B. ,
CustomMultiLabelClassification: For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
}
,
Required: True ,
}
enum ,
storageInputContainerName:
{
Description: The storage container name. ,
Required: True ,
}
string ,
settings:
{
Description: The project settings. ,
Required: False ,
}
{
confidenceThreshold:
{
Description: The threshold of the class with the highest confidence, at which the prediction will automatically be changed to "None". The value of the threshold should be between 0 and 1 inclusive. ,
Format: float ,
Required: False ,
}
number ,
}
,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
multilingual:
{
Description: Whether the project would be used for multiple languages or not. ,
Required: False ,
}
boolean ,
description:
{
Description: The project description. ,
Required: False ,
}
string ,
language:
{
Description: The project language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
createdDateTime:
{
Description: Represents the project creation datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedDateTime:
{
Description: Represents the project last modification datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: Represents the project last training datetime. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeployedDateTime:
{
Description: Represents the project last deployment datetime. ,
Format: date-time ,
Required: False ,
}
string ,
projectKind:
{
Description: The project kind. ,
Enum:
{
CustomSingleLabelClassification: For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B. ,
CustomMultiLabelClassification: For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
}
,
Required: True ,
}
enum ,
storageInputContainerName:
{
Description: The storage container name. ,
Required: True ,
}
string ,
settings:
{
Description: The project settings. ,
Required: False ,
}
{
confidenceThreshold:
{
Description: The threshold of the class with the highest confidence, at which the prediction will automatically be changed to "None". The value of the threshold should be between 0 and 1 inclusive. ,
Format: float ,
Required: False ,
}
number ,
}
,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
multilingual:
{
Description: Whether the project would be used for multiple languages or not. ,
Required: False ,
}
boolean ,
description:
{
Description: The project description. ,
Required: False ,
}
string ,
language:
{
Description: The project language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
createdDateTime:
{
Description: Represents the project creation datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedDateTime:
{
Description: Represents the project last modification datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: Represents the project last training datetime. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeployedDateTime:
{
Description: Represents the project last deployment datetime. ,
Format: date-time ,
Required: False ,
}
string ,
projectKind:
{
Description: The project kind. ,
Enum:
{
CustomSingleLabelClassification: For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B. ,
CustomMultiLabelClassification: For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
}
,
Required: True ,
}
enum ,
storageInputContainerName:
{
Description: The storage container name. ,
Required: True ,
}
string ,
settings:
{
Description: The project settings. ,
Required: False ,
}
{
confidenceThreshold:
{
Description: The threshold of the class with the highest confidence, at which the prediction will automatically be changed to "None". The value of the threshold should be between 0 and 1 inclusive. ,
Format: float ,
Required: False ,
}
number ,
}
,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
multilingual:
{
Description: Whether the project would be used for multiple languages or not. ,
Required: False ,
}
boolean ,
description:
{
Description: The project description. ,
Required: False ,
}
string ,
language:
{
Description: The project language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringProject_DeleteProject (removed)
Description :  Deletes a project.
Reference :  Link ¶

⚼ Request

DELETE:  /authoring/analyze-text/projects/{projectName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringProject_Export (removed)
Description :  Triggers a job to export a project's data.
Reference :  Link ¶

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/:export
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
stringIndexType:
{
Description: Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets. ,
Required: True ,
}
string ,
assetKind:
{
Description: Kind of asset to export. ,
Required: False ,
}
string ,
trainedModelLabel:
{
Description: Trained model label to export. If the trainedModelLabel is null, the default behavior is to export the current working copy. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringProject_Import (removed)
Description :  Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.
Reference :  Link ¶

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/:import
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
body:
{
Description: The project data to import. ,
Required: True ,
}
{
projectFileVersion:
{
Description: The version of the exported file. ,
Required: True ,
}
string ,
stringIndexType:
{
Description: Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets. ,
Enum:
{
Utf16CodeUnit: The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript. ,
}
,
Required: True ,
}
enum ,
metadata:
{
Description: Represents the project metadata. ,
Required: True ,
}
{
projectKind:
{
Description: The project kind. ,
Enum:
{
CustomSingleLabelClassification: For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B. ,
CustomMultiLabelClassification: For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
}
,
Required: True ,
}
enum ,
storageInputContainerName:
{
Description: The storage container name. ,
Required: True ,
}
string ,
settings:
{
Description: The project settings. ,
Required: False ,
}
{
confidenceThreshold:
{
Description: The threshold of the class with the highest confidence, at which the prediction will automatically be changed to "None". The value of the threshold should be between 0 and 1 inclusive. ,
Format: float ,
Required: False ,
}
number ,
}
,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
multilingual:
{
Description: Whether the project would be used for multiple languages or not. ,
Required: False ,
}
boolean ,
description:
{
Description: The project description. ,
Required: False ,
}
string ,
language:
{
Description: The project language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. ,
Required: True ,
}
string ,
}
,
assets:
{
Description: Represents the project assets. ,
Required: False ,
}
{
projectKind:
{
Enum:
{
CustomSingleLabelClassification: For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B. ,
CustomMultiLabelClassification: For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringProject_Train (removed)
Description :  Triggers a training job for a project.
Reference :  Link ¶

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/:train
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
body:
{
Description: The training input parameters. ,
Required: True ,
}
{
modelLabel:
{
Description: Represents the output model label. ,
Required: True ,
}
string ,
trainingConfigVersion:
{
Description: Represents training config version. ,
Required: True ,
}
string ,
evaluationOptions:
{
Description: Represents the evaluation options. By default, the evaluation kind is percentage, with training split percentage as 80, and testing split percentage as 20. ,
Required: False ,
}
{
kind:
{
Description: Represents the evaluation kind. By default, the evaluation kind is set to percentage. ,
Enum:
{
percentage: Split the data into training and test sets according to user-defined percentages. ,
manual: Split the data according to the chosen dataset for every example in the data. ,
}
,
Required: False ,
}
enum ,
trainingSplitPercentage:
{
Description: Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage. ,
Format: int32 ,
Required: False ,
}
integer ,
testingSplitPercentage:
{
Description: Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAnalysisAuthoringListDeployments (removed)
Description :  Lists the deployments belonging to a project.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/deployments
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The TextAnalysisAuthoringProjectDeployment items on this page ,
Required: True ,
}
[
{
deploymentName:
{
Description: Represents deployment name. ,
Required: True ,
}
string ,
modelId:
{
Description: Represents deployment modelId. ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: Represents deployment last trained time. ,
Format: date-time ,
Required: True ,
}
string ,
lastDeployedDateTime:
{
Description: Represents deployment last deployed time. ,
Format: date-time ,
Required: True ,
}
string ,
deploymentExpirationDate:
{
Description: Represents deployment expiration date in the runtime. ,
Format: date ,
Required: True ,
}
string ,
modelTrainingConfigVersion:
{
Description: Represents model training config version. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringDeployment_GetDeployment (removed)
Description :  Gets the details of a deployment.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
deploymentName:
{
Description: Represents deployment name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
deploymentName:
{
Description: Represents deployment name. ,
Required: True ,
}
string ,
modelId:
{
Description: Represents deployment modelId. ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: Represents deployment last trained time. ,
Format: date-time ,
Required: True ,
}
string ,
lastDeployedDateTime:
{
Description: Represents deployment last deployed time. ,
Format: date-time ,
Required: True ,
}
string ,
deploymentExpirationDate:
{
Description: Represents deployment expiration date in the runtime. ,
Format: date ,
Required: True ,
}
string ,
modelTrainingConfigVersion:
{
Description: Represents model training config version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringDeployment_DeployProject (removed)
Description :  Creates a new deployment or replaces an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the specific deployment of the project to use. ,
Required: True ,
}
string ,
body:
{
Description: The new deployment info. ,
Required: True ,
}
{
trainedModelLabel:
{
Description: Represents the trained model label. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringDeployment_DeleteDeployment (removed)
Description :  Deletes a project deployment.
Reference :  Link ¶

⚼ Request

DELETE:  /authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the specific deployment of the project to use. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringDeployment_GetDeploymentStatus (removed)
Description :  Gets the status of an existing deployment job.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
deploymentName:
{
Description: Represents deployment name. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: The creation date time of the job. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdatedDateTime:
{
Description: The last date time the job was updated. ,
Format: date-time ,
Required: True ,
}
string ,
expirationDateTime:
{
Description: The expiration date time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The job status. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
warnings:
{
Description: The warnings that were encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
errors:
{
Description: The errors encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringProject_SwapDeployments (removed)
Description :  Swaps two existing deployments with each other.
Reference :  Link ¶

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/deployments/:swap
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
body:
{
Description: The job object to swap two deployments. ,
Required: True ,
}
{
firstDeploymentName:
{
Description: Represents the first deployment name. ,
Required: True ,
}
string ,
secondDeploymentName:
{
Description: Represents the second deployment name. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringProject_GetSwapDeploymentsStatus (removed)
Description :  Gets the status of an existing swap deployment job.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/deployments/swap/jobs/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: The creation date time of the job. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdatedDateTime:
{
Description: The last date time the job was updated. ,
Format: date-time ,
Required: True ,
}
string ,
expirationDateTime:
{
Description: The expiration date time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The job status. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
warnings:
{
Description: The warnings that were encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
errors:
{
Description: The errors encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringProject_GetExportStatus (removed)
Description :  Gets the status of an export job. Once job completes, returns the project metadata, and assets.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/export/jobs/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: The creation date time of the job. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdatedDateTime:
{
Description: The last date time the job was updated. ,
Format: date-time ,
Required: True ,
}
string ,
expirationDateTime:
{
Description: The expiration date time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The job status. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
warnings:
{
Description: The warnings that were encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
errors:
{
Description: The errors encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
resultUrl:
{
Description: The URL to use in order to download the exported project. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringProject_GetImportStatus (removed)
Description :  Gets the status for an import.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/import/jobs/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: The creation date time of the job. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdatedDateTime:
{
Description: The last date time the job was updated. ,
Format: date-time ,
Required: True ,
}
string ,
expirationDateTime:
{
Description: The expiration date time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The job status. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
warnings:
{
Description: The warnings that were encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
errors:
{
Description: The errors encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAnalysisAuthoringListTrainedModels (removed)
Description :  Lists the trained models belonging to a project.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/models
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The TextAnalysisAuthoringProjectTrainedModel items on this page ,
Required: True ,
}
[
{
label:
{
Description: The trained model label. ,
Required: True ,
}
string ,
modelId:
{
Description: The model ID. ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: The last trained date time of the model. ,
Format: date-time ,
Required: True ,
}
string ,
lastTrainingDurationInSeconds:
{
Description: The duration of the model's last training request in seconds. ,
Format: int32 ,
Required: True ,
}
integer ,
modelExpirationDate:
{
Description: The model expiration date. ,
Format: date ,
Required: True ,
}
string ,
modelTrainingConfigVersion:
{
Description: The model training config version. ,
Required: True ,
}
string ,
hasSnapshot:
{
Description: The flag to indicate if the trained model has a snapshot ready. ,
Required: True ,
}
boolean ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringTrainedModel_GetTrainedModel (removed)
Description :  Gets the details of a trained model.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
trainedModelLabel:
{
Description: The trained model label. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
label:
{
Description: The trained model label. ,
Required: True ,
}
string ,
modelId:
{
Description: The model ID. ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: The last trained date time of the model. ,
Format: date-time ,
Required: True ,
}
string ,
lastTrainingDurationInSeconds:
{
Description: The duration of the model's last training request in seconds. ,
Format: int32 ,
Required: True ,
}
integer ,
modelExpirationDate:
{
Description: The model expiration date. ,
Format: date ,
Required: True ,
}
string ,
modelTrainingConfigVersion:
{
Description: The model training config version. ,
Required: True ,
}
string ,
hasSnapshot:
{
Description: The flag to indicate if the trained model has a snapshot ready. ,
Required: True ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringTrainedModel_DeleteTrainedModel (removed)
Description :  Deletes an existing trained model.
Reference :  Link ¶

⚼ Request

DELETE:  /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
trainedModelLabel:
{
Description: The trained model label. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringTrainedModel_LoadSnapshot (removed)
Description :  Long-running operation.
Reference :  Link ¶

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/:load-snapshot
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
trainedModelLabel:
{
Description: The trained model label. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringTrainedModel_GetModelEvaluationResults (removed)
Description :  Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/result
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
trainedModelLabel:
{
Description: The trained model label. ,
Required: True ,
}
string ,
top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
stringIndexType:
{
Description: Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The TextAnalysisAuthoringDocumentEvaluationResult items on this page ,
Required: True ,
}
[
{
projectKind:
{
Description: Represents the project kind. ,
Enum:
{
CustomSingleLabelClassification: For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B. ,
CustomMultiLabelClassification: For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
}
,
Required: True ,
}
enum ,
location:
{
Description: Represents the document path. ,
Required: True ,
}
string ,
language:
{
Description: Represents the document language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringTrainedModel_GetModelEvaluationSummary (removed)
Description :  Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
trainedModelLabel:
{
Description: The trained model label. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
projectKind:
{
Description: Represents the project type that the evaluation ran on. ,
Enum:
{
CustomSingleLabelClassification: For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B. ,
CustomMultiLabelClassification: For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
}
,
Required: True ,
}
enum ,
evaluationOptions:
{
Description: Represents the options used running the evaluation. ,
Required: True ,
}
{
kind:
{
Description: Represents the evaluation kind. By default, the evaluation kind is set to percentage. ,
Enum:
{
percentage: Split the data into training and test sets according to user-defined percentages. ,
manual: Split the data according to the chosen dataset for every example in the data. ,
}
,
Required: False ,
}
enum ,
trainingSplitPercentage:
{
Description: Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage. ,
Format: int32 ,
Required: False ,
}
integer ,
testingSplitPercentage:
{
Description: Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringTrainedModel_GetLoadSnapshotStatus (removed)
Description :  Gets the status for loading a snapshot.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/load-snapshot/jobs/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
trainedModelLabel:
{
Description: The trained model label. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: The creation date time of the job. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdatedDateTime:
{
Description: The last date time the job was updated. ,
Format: date-time ,
Required: True ,
}
string ,
expirationDateTime:
{
Description: The expiration date time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The job status. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
warnings:
{
Description: The warnings that were encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
errors:
{
Description: The errors encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAnalysisAuthoringListTrainingJobs (removed)
Description :  Lists the non-expired training jobs created for a project.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/train/jobs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The TextAnalysisAuthoringTrainingJobState items on this page ,
Required: True ,
}
[
{
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: The creation date time of the job. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdatedDateTime:
{
Description: The last date time the job was updated. ,
Format: date-time ,
Required: True ,
}
string ,
expirationDateTime:
{
Description: The expiration date time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The job status. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
warnings:
{
Description: The warnings that were encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
errors:
{
Description: The errors encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
result:
{
Description: Represents training tasks detailed result. ,
Required: True ,
}
{
modelLabel:
{
Description: Represents trained model label. ,
Required: True ,
}
string ,
trainingConfigVersion:
{
Description: Represents training config version. ,
Required: True ,
}
string ,
trainingStatus:
{
Description: Represents model train status. ,
Required: True ,
}
{
percentComplete:
{
Description: Represents progress percentage. ,
Format: int32 ,
Required: True ,
}
integer ,
startDateTime:
{
Description: Represents the start date time. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Represents the end date time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Represents the status of the sub-operation. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
evaluationStatus:
{
Description: Represents model evaluation status. ,
Required: False ,
}
{
percentComplete:
{
Description: Represents progress percentage. ,
Format: int32 ,
Required: True ,
}
integer ,
startDateTime:
{
Description: Represents the start date time. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Represents the end date time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Represents the status of the sub-operation. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
estimatedEndDateTime:
{
Description: Represents the estimate end date time for training and evaluation. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringProject_GetTrainingStatus (removed)
Description :  Gets the status for a training job.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: The creation date time of the job. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdatedDateTime:
{
Description: The last date time the job was updated. ,
Format: date-time ,
Required: True ,
}
string ,
expirationDateTime:
{
Description: The expiration date time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The job status. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
warnings:
{
Description: The warnings that were encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
errors:
{
Description: The errors encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
result:
{
Description: Represents training tasks detailed result. ,
Required: True ,
}
{
modelLabel:
{
Description: Represents trained model label. ,
Required: True ,
}
string ,
trainingConfigVersion:
{
Description: Represents training config version. ,
Required: True ,
}
string ,
trainingStatus:
{
Description: Represents model train status. ,
Required: True ,
}
{
percentComplete:
{
Description: Represents progress percentage. ,
Format: int32 ,
Required: True ,
}
integer ,
startDateTime:
{
Description: Represents the start date time. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Represents the end date time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Represents the status of the sub-operation. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
evaluationStatus:
{
Description: Represents model evaluation status. ,
Required: False ,
}
{
percentComplete:
{
Description: Represents progress percentage. ,
Format: int32 ,
Required: True ,
}
integer ,
startDateTime:
{
Description: Represents the start date time. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Represents the end date time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Represents the status of the sub-operation. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
estimatedEndDateTime:
{
Description: Represents the estimate end date time for training and evaluation. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringProject_CancelTrainingJob (removed)
Description :  Triggers a cancellation for a running training job.
Reference :  Link ¶

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}/:cancel
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAuthoringProject_GetProjectDeletionStatus (removed)
Description :  Gets the status for a project deletion job.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/global/deletion-jobs/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: The creation date time of the job. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdatedDateTime:
{
Description: The last date time the job was updated. ,
Format: date-time ,
Required: True ,
}
string ,
expirationDateTime:
{
Description: The expiration date time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The job status. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
warnings:
{
Description: The warnings that were encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
errors:
{
Description: The errors encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAnalysisAuthoringGetSupportedLanguages (removed)
Description :  Lists the supported languages.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/global/languages
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectKind:
{
Description: The project kind, default value is CustomSingleLabelClassification. ,
Required: False ,
}
string ,
top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The TextAnalysisAuthoringSupportedLanguage items on this page ,
Required: True ,
}
[
{
languageName:
{
Description: The language name. ,
Required: True ,
}
string ,
languageCode:
{
Description: The language code. This is BCP-47 representation of a language. For example, "en" for English, "en-gb" for English (UK), "es" for Spanish etc. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TextAnalysisAuthoringListTrainingConfigVersions (removed)
Description :  Lists the support training config version for a given project type.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-text/projects/global/training-config-versions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectKind:
{
Description: The project kind, default value is CustomSingleLabelClassification. ,
Required: False ,
}
string ,
top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The TextAnalysisAuthoringTrainingConfigVersion items on this page ,
Required: True ,
}
[
{
trainingConfigVersion:
{
Description: Represents the version of the config. ,
Required: True ,
}
string ,
modelExpirationDate:
{
Description: Represents the training config version expiration date. ,
Format: date ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}